Package-level declarations
Types
Data model used for DHIS2 CarouselButton component.
Data model used for DHIS2 CheckBox component.
Data model used for DHIS2 Metadata Icon component.
Data model used for DHIS2 InfoBar component.
Data model used for DHIS2 InputAge component.
UiModel used for InputDateTime
DHIS2 InputShellState, enum class to control the state InputShell component
DHIS2 Input Shell style. Used internally by InputShell.
Data class used for DHIS2 Legend component.
Data class used for DHIS2 LegendRange component.
DHIS2 Location Bar search actions Default: The user will need to select a result to mark it as selected OnOneItemSelect: If only one item is available, it will be selected automatically
Data class used for OrgBottomSheet used to hold information on Organisation Units.
Data model used for DHIS2 RadioButton component.
DHIS2 Location Bar modes BUTTON: the Location Bar is displayed as a button and shows current search query if available. SEARCH: The Location Bar is displayed as an input and displays available location items.
Enum class representing the type of the TopBar.
Properties
Functions
DHIS2 AssistChip button with custom icon slot. wraps Material 3 AssistChip. AssistChips are used to trigger actions.
DHIS2 Avatar, used to display the avatar composable in card, must be one of the three styles given as parameters
DHIS2 Badge) wraps androidx.compose.material3.Badge. Badges are used to convey dynamic information, such as a count or status. A badge can include text, labels, or numbers.
Container to render barcode image and text for given data.
DHIS2 Basic Input. Wraps Material 3· BasicTextField.
DHIS2 BottomSheetHeader component designed to be used within BottomSheetShell
DHIS2 BottomSheetShell. Wraps compose · ModalBottomSheet. desktop version to be implemented
DHIS2 button with generic icon slot. wraps DHIS2 SimpleButton which in turn wraps material 3 Button.
DHIS2 ButtonBlock with generic buttons slot.
Component used to display a horizontal list of CarouselButton.
DHIS2 CardDetail. Component intended for TEI Dashboard
DHIS2 CarouselButton.
DHIS2 check box block.
DHIS2 ColumnComponentContainer wraps Material 3 Column has a default spacing between items of 16 dp
DHIS2 ColumnScreenContainer wraps Material 3 Column has a default spacing between items of 16 dp with large top corner radius, white background and vertical scroll enabled
DHIS2 DropDownInputField. Wraps DHIS · InputShell.
DHIS2 ExtendedFAB button with generic icon slot. wraps Material 3 ExtendedFloatingActionButton. FABs help people take primary actions. They’re used to represent the most important action on a screen.
DHIS2 FAB button with generic icon slot. wraps Material 3 FloatingActionButton. FABs help people take primary actions. They’re used to represent the most important action on a screen.
DHIS2 FilterChip button with generic icon slot. wraps Material 3 FilterChip. Chips help people enter information, make selections, filter content, or trigger actions.
DHIS2 FlowColumnComponentsContainer wraps Material 3 FlowColumn.
DHIS2 FlowRowComponentsContainer wraps Material 3 FlowRow.
DHIS2 icon button with generic icon slot.
DHIS2 Indicator. Wraps compose Row. A component designed to display indicators, each featuring a key and a value, is complemented by a color badge for visual distinction. This configuration allows for clear and efficient presentation of important data points.
DHIS2 InfoBar. Wraps compose Row. InfoBars provide brief messages about app status.
DHIS2 Input Age component wraps DHIS2 InputShell. Users can enter their age either through Material 3's DatePicker or through a Unit Interval selector that can be TimeUnitValues.YEARS, TimeUnitValues.MONTHS or TimeUnitValues.DAYS.
DHIS2 Input Age Input field to enter age. It will format content based on given visual transformation. component uses Material 3 DatePicker input formats supported are mentioned in the age input ui model documentation. DatePicker Input mode will always follow locale format.
DHIS2 Input QR Code. Wraps DHIS · BasicTextInput.
DHIS2 Input Check Box. Wraps DHIS · InputShell.
DHIS2 Input Chip. Wraps material 3 · InputChip.
DHIS2 Input coordinate. Wraps DHIS · InputShell.
DHIS2 Input Date Time Input field to enter date, time or date&time. It will format content based on given visual transformation. component uses Material 3 DatePicker and TimePicker input formats supported are mentioned in the date time input ui model documentation. DatePicker Input mode will always follow locale format.
DHIS2 Input dropdown. Wraps DHIS · DropdownInputField.
DHIS2 Input email. Wraps DHIS · BasicTextInput.
DHIS2 Input File Resource. Wraps DHIS · InputShell.
DHIS2 Input image. Wraps DHIS · BasicInputImage.
DHIS2 Input Integer. Wraps DHIS · BasicTextInput. Only positive or negative integers allowed, excluding 0.
DHIS2 Input Letter. Wraps DHIS · BasicTextInput. Component that only allows a single character, must be a single letter.
DHIS2 Input link. Wraps DHIS · BasicTextInput.
DHIS2 Input Long Text. Wraps DHIS · BasicTextInput.
DHIS2 icon card matrix input component
DHIS2 input multi selection component. wraps DHIS2 InputShell.
DHIS2 Input negative Integer. Wraps DHIS · BasicTextInput. Only negative integers allowed.
Input for unsupported components
DHIS2 Input Number. Wraps DHIS · BasicTextInput. Input that allows only numeric values.
DHIS2 Input org unit.
DHIS2 Input Password.
DHIS2 Input percentage. Wraps DHIS · BasicTextInput. Only integers allowed.
DHIS2 Input Phone Number. Wraps DHIS · BasicTextInput. Input that allows only numeric values for entering phone number.
DHIS2 Input polygon. Wraps DHIS · InputShell.
DHIS2 Input positive Integer. Wraps DHIS · BasicTextInput. Only positive integers allowed, excluding 0.
DHIS2 Input positive Integer or zero. Wraps DHIS · BasicTextInput. Only positive integers allowed, including 0.
DHIS2 Input QR Code. Wraps DHIS · BasicTextInput.
DHIS2 Input Radio Button. Wraps DHIS · RadioButton.
DHIS2 icon card sequential input component.
DHIS2 Input signature. Wraps DHIS · BasicInputImage.
DHIS2 Input Text. Wraps DHIS · BasicTextInput.
DHIS2 Input Unit Interval. Wraps DHIS · BasicTextInput.
DHIS2 Input User. Wraps DHIS · BasicTextInput.
DHIS2 Input Yes/No Field. Wraps DHIS · RadioButton.
DHIS2 Input Yes Only Check box. Wraps DHIS · InputShell.
DHIS2 Input Yes Only Switch. Wraps DHIS · InputShell.
DHIS2 Legend. Used to display information on input value based on a range of values.
DHIS2 Legend Range. Used to a list of LegendDescription items.
DHIS2 ListCard. Component intended for TEI/Event/DataSet card display.
DHIS2 ListCardColumn wraps Material 3 Column has a default spacing between items of 4 dp vertical scroll enabled
DHIS2 Location Bar.
DHIS2 Location Item icon.
DHIS2 Metadata Avatar.
DHIS2 Metadata Icon.
DHIS2 OrgBottomSheet component designed to be used with Input Org Unit, wraps DHIS2 BottomSheetShell.
DHIS2 Progress indicator Progress indicators inform users about the status of ongoing processes, such as loading an app, submitting a form, or saving updates. They communicate an app’s state and indicate available actions, such as whether users can navigate away from the current screen.
Container to render QR code image and text for given data
DHIS2 radio button with or without text. Wraps Material 3 RadioButton.
DHIS2 radio button block.
DHIS2 RowComponentContainer wraps Material 3 Row
DHIS2 Search bar.
DHIS2 Section
DHIS2 square icon button with generic icon slot. Wraps Material 3 ElevatedButton.
DHIS2 SupportingText component, wraps Compose ClickableText.
DHIS2 Tag Short labels or identifiers used to categorize and organize elements, making them easier to locate and understand.
DHIS2 TextButtonSelector
A composable function that renders a top app bar. Depending on the type, it can display either a default aligned top app bar or a center-aligned top app bar.
A composable function that renders an action icon within the TopBar.
A composable function that renders an icon button which toggles a dropdown menu.
DHIS2 VerticalListCard. Component intended for Program/DataSet card display.